<HTML>
<BODY BGCOLOR="white">
<PRE>
<FONT color="green">001</FONT>    /*<a name="line.1"></a>
<FONT color="green">002</FONT>     Copyright 2010 Regents of the University of Colorado.<a name="line.2"></a>
<FONT color="green">003</FONT>     All rights reserved.<a name="line.3"></a>
<FONT color="green">004</FONT>    <a name="line.4"></a>
<FONT color="green">005</FONT>     Licensed under the Apache License, Version 2.0 (the "License");<a name="line.5"></a>
<FONT color="green">006</FONT>     you may not use this file except in compliance with the License.<a name="line.6"></a>
<FONT color="green">007</FONT>     You may obtain a copy of the License at<a name="line.7"></a>
<FONT color="green">008</FONT>    <a name="line.8"></a>
<FONT color="green">009</FONT>     http://www.apache.org/licenses/LICENSE-2.0<a name="line.9"></a>
<FONT color="green">010</FONT>    <a name="line.10"></a>
<FONT color="green">011</FONT>     Unless required by applicable law or agreed to in writing, software<a name="line.11"></a>
<FONT color="green">012</FONT>     distributed under the License is distributed on an "AS IS" BASIS,<a name="line.12"></a>
<FONT color="green">013</FONT>     WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.<a name="line.13"></a>
<FONT color="green">014</FONT>     See the License for the specific language governing permissions and<a name="line.14"></a>
<FONT color="green">015</FONT>     limitations under the License.<a name="line.15"></a>
<FONT color="green">016</FONT>     */<a name="line.16"></a>
<FONT color="green">017</FONT>    <a name="line.17"></a>
<FONT color="green">018</FONT>    package org.uimafit.factory;<a name="line.18"></a>
<FONT color="green">019</FONT>    <a name="line.19"></a>
<FONT color="green">020</FONT>    import java.util.ArrayList;<a name="line.20"></a>
<FONT color="green">021</FONT>    import java.util.Arrays;<a name="line.21"></a>
<FONT color="green">022</FONT>    import java.util.List;<a name="line.22"></a>
<FONT color="green">023</FONT>    <a name="line.23"></a>
<FONT color="green">024</FONT>    import org.apache.uima.analysis_engine.AnalysisEngine;<a name="line.24"></a>
<FONT color="green">025</FONT>    import org.apache.uima.analysis_engine.AnalysisEngineDescription;<a name="line.25"></a>
<FONT color="green">026</FONT>    import org.apache.uima.analysis_engine.metadata.SofaMapping;<a name="line.26"></a>
<FONT color="green">027</FONT>    import org.apache.uima.flow.FlowControllerDescription;<a name="line.27"></a>
<FONT color="green">028</FONT>    import org.apache.uima.resource.ResourceInitializationException;<a name="line.28"></a>
<FONT color="green">029</FONT>    import org.apache.uima.resource.metadata.TypePriorities;<a name="line.29"></a>
<FONT color="green">030</FONT>    import org.apache.uima.resource.metadata.TypeSystemDescription;<a name="line.30"></a>
<FONT color="green">031</FONT>    <a name="line.31"></a>
<FONT color="green">032</FONT>    /**<a name="line.32"></a>
<FONT color="green">033</FONT>     * This builder makes it easier to create an aggregate analysis engine. A typical use-case would<a name="line.33"></a>
<FONT color="green">034</FONT>     * involve initializing this builder with your preferred type system and type priorities (the latter<a name="line.34"></a>
<FONT color="green">035</FONT>     * may be null). This is followed by adding analysis engine descriptions one at a time until done.<a name="line.35"></a>
<FONT color="green">036</FONT>     * This makes it easy to have runtime decisions determine how the aggregate engine should be built.<a name="line.36"></a>
<FONT color="green">037</FONT>     * Finally, one of the create methods are called and an AnalysisEngine or AnalysisEngineDescription<a name="line.37"></a>
<FONT color="green">038</FONT>     * is returned.<a name="line.38"></a>
<FONT color="green">039</FONT>     *<a name="line.39"></a>
<FONT color="green">040</FONT>     * &lt;p&gt;This is an example taken from our test cases:&lt;/p&gt;<a name="line.40"></a>
<FONT color="green">041</FONT>     *<a name="line.41"></a>
<FONT color="green">042</FONT>     * &lt;p&gt;&lt;blockquote&gt;&lt;pre&gt;<a name="line.42"></a>
<FONT color="green">043</FONT>     * import static org.uimafit.factory.AnalysisEngineFactory.createPrimitiveDescription;<a name="line.43"></a>
<FONT color="green">044</FONT>     *<a name="line.44"></a>
<FONT color="green">045</FONT>     * AggregateBuilder builder = new AggregateBuilder();<a name="line.45"></a>
<FONT color="green">046</FONT>     * builder.add(createPrimitiveDescription(Annotator1.class, typeSystemDescription),<a name="line.46"></a>
<FONT color="green">047</FONT>     *     ViewNames.PARENTHESES_VIEW, "A");<a name="line.47"></a>
<FONT color="green">048</FONT>     * builder.add(createPrimitiveDescription(Annotator2.class, typeSystemDescription),<a name="line.48"></a>
<FONT color="green">049</FONT>     *     ViewNames.SORTED_VIEW, "B",<a name="line.49"></a>
<FONT color="green">050</FONT>     *     ViewNames.SORTED_PARENTHESES_VIEW, "C",<a name="line.50"></a>
<FONT color="green">051</FONT>     *     ViewNames.PARENTHESES_VIEW, "A");<a name="line.51"></a>
<FONT color="green">052</FONT>     * builder.add(createPrimitiveDescription(Annotator3.class, typeSystemDescription),<a name="line.52"></a>
<FONT color="green">053</FONT>     *     ViewNames.INITIAL_VIEW, "B");<a name="line.53"></a>
<FONT color="green">054</FONT>     * AnalysisEngine aggregateEngine = builder.createAggregate();<a name="line.54"></a>
<FONT color="green">055</FONT>     * &lt;/pre&gt;&lt;/blockquote&gt;&lt;/p&gt;<a name="line.55"></a>
<FONT color="green">056</FONT>     *<a name="line.56"></a>
<FONT color="green">057</FONT>     * @author Philip Ogren<a name="line.57"></a>
<FONT color="green">058</FONT>     */<a name="line.58"></a>
<FONT color="green">059</FONT>    public class AggregateBuilder {<a name="line.59"></a>
<FONT color="green">060</FONT>    <a name="line.60"></a>
<FONT color="green">061</FONT>            List&lt;String&gt; componentNames = new ArrayList&lt;String&gt;();<a name="line.61"></a>
<FONT color="green">062</FONT>    <a name="line.62"></a>
<FONT color="green">063</FONT>            List&lt;SofaMapping&gt; sofaMappings = new ArrayList&lt;SofaMapping&gt;();<a name="line.63"></a>
<FONT color="green">064</FONT>    <a name="line.64"></a>
<FONT color="green">065</FONT>            List&lt;AnalysisEngineDescription&gt; analysisEngineDescriptions = new ArrayList&lt;AnalysisEngineDescription&gt;();<a name="line.65"></a>
<FONT color="green">066</FONT>    <a name="line.66"></a>
<FONT color="green">067</FONT>            TypeSystemDescription typeSystemDescription;<a name="line.67"></a>
<FONT color="green">068</FONT>    <a name="line.68"></a>
<FONT color="green">069</FONT>            TypePriorities typePriorities;<a name="line.69"></a>
<FONT color="green">070</FONT>    <a name="line.70"></a>
<FONT color="green">071</FONT>            FlowControllerDescription flowControllerDescription;<a name="line.71"></a>
<FONT color="green">072</FONT>    <a name="line.72"></a>
<FONT color="green">073</FONT>            /**<a name="line.73"></a>
<FONT color="green">074</FONT>             * The default no-args constructor calls<a name="line.74"></a>
<FONT color="green">075</FONT>             * {@link AggregateBuilder#AggregateBuilder(TypeSystemDescription, TypePriorities, FlowControllerDescription)}<a name="line.75"></a>
<FONT color="green">076</FONT>             * with null-valued args.<a name="line.76"></a>
<FONT color="green">077</FONT>             */<a name="line.77"></a>
<FONT color="green">078</FONT>            public AggregateBuilder() {<a name="line.78"></a>
<FONT color="green">079</FONT>                    this(null, null, null);<a name="line.79"></a>
<FONT color="green">080</FONT>            }<a name="line.80"></a>
<FONT color="green">081</FONT>    <a name="line.81"></a>
<FONT color="green">082</FONT>            /**<a name="line.82"></a>
<FONT color="green">083</FONT>             * Instantiate an AggregateBuilder with a given type system, type priorities, and flow<a name="line.83"></a>
<FONT color="green">084</FONT>             * controller. Generally, speaking it suffices to use the no arguments constructor<a name="line.84"></a>
<FONT color="green">085</FONT>             *<a name="line.85"></a>
<FONT color="green">086</FONT>             * @param typeSystemDescription<a name="line.86"></a>
<FONT color="green">087</FONT>             *            this can be instantiated using {@link TypeSystemDescriptionFactory}<a name="line.87"></a>
<FONT color="green">088</FONT>             * @param typePriorities<a name="line.88"></a>
<FONT color="green">089</FONT>             *            this can be instantiated using {@link TypePrioritiesFactory}<a name="line.89"></a>
<FONT color="green">090</FONT>             * @param flowControllerDescription<a name="line.90"></a>
<FONT color="green">091</FONT>             *            this can be instantiated using {@link FlowControllerFactory}<a name="line.91"></a>
<FONT color="green">092</FONT>             */<a name="line.92"></a>
<FONT color="green">093</FONT>            public AggregateBuilder(TypeSystemDescription typeSystemDescription,<a name="line.93"></a>
<FONT color="green">094</FONT>                            TypePriorities typePriorities, FlowControllerDescription flowControllerDescription) {<a name="line.94"></a>
<FONT color="green">095</FONT>                    this.typeSystemDescription = typeSystemDescription;<a name="line.95"></a>
<FONT color="green">096</FONT>                    this.typePriorities = typePriorities;<a name="line.96"></a>
<FONT color="green">097</FONT>                    this.flowControllerDescription = flowControllerDescription;<a name="line.97"></a>
<FONT color="green">098</FONT>            }<a name="line.98"></a>
<FONT color="green">099</FONT>    <a name="line.99"></a>
<FONT color="green">100</FONT>            /**<a name="line.100"></a>
<FONT color="green">101</FONT>             * This method simply calls {@link #add(String, AnalysisEngineDescription, String...)} using the<a name="line.101"></a>
<FONT color="green">102</FONT>             * result of {@link AnalysisEngineDescription#getAnnotatorImplementationName()} for the<a name="line.102"></a>
<FONT color="green">103</FONT>             * component name<a name="line.103"></a>
<FONT color="green">104</FONT>             *<a name="line.104"></a>
<FONT color="green">105</FONT>             * @param aed<a name="line.105"></a>
<FONT color="green">106</FONT>             * @param viewNames<a name="line.106"></a>
<FONT color="green">107</FONT>             * @return the name of the component generated for the {@link AnalysisEngineDescription}<a name="line.107"></a>
<FONT color="green">108</FONT>             */<a name="line.108"></a>
<FONT color="green">109</FONT>            public String add(AnalysisEngineDescription aed, String... viewNames) {<a name="line.109"></a>
<FONT color="green">110</FONT>                    String componentName = aed.getAnalysisEngineMetaData().getName();<a name="line.110"></a>
<FONT color="green">111</FONT>                    if (componentName == null || componentName.equals("")) {<a name="line.111"></a>
<FONT color="green">112</FONT>                            if (aed.isPrimitive()) {<a name="line.112"></a>
<FONT color="green">113</FONT>                                    componentName = aed.getAnnotatorImplementationName();<a name="line.113"></a>
<FONT color="green">114</FONT>                            }<a name="line.114"></a>
<FONT color="green">115</FONT>                            else {<a name="line.115"></a>
<FONT color="green">116</FONT>                                    componentName = "aggregate";<a name="line.116"></a>
<FONT color="green">117</FONT>                            }<a name="line.117"></a>
<FONT color="green">118</FONT>                    }<a name="line.118"></a>
<FONT color="green">119</FONT>                    if (componentNames.contains(componentName)) {<a name="line.119"></a>
<FONT color="green">120</FONT>                            componentName = componentName + "." + (componentNames.size() + 1);<a name="line.120"></a>
<FONT color="green">121</FONT>                    }<a name="line.121"></a>
<FONT color="green">122</FONT>                    add(componentName, aed, viewNames);<a name="line.122"></a>
<FONT color="green">123</FONT>                    return componentName;<a name="line.123"></a>
<FONT color="green">124</FONT>            }<a name="line.124"></a>
<FONT color="green">125</FONT>    <a name="line.125"></a>
<FONT color="green">126</FONT>            /**<a name="line.126"></a>
<FONT color="green">127</FONT>             * @param componentName<a name="line.127"></a>
<FONT color="green">128</FONT>             *            the name of the component to add<a name="line.128"></a>
<FONT color="green">129</FONT>             * @param aed<a name="line.129"></a>
<FONT color="green">130</FONT>             *            an analysis engine description to add to the aggregate analysis engine<a name="line.130"></a>
<FONT color="green">131</FONT>             * @param viewNames<a name="line.131"></a>
<FONT color="green">132</FONT>             *            pairs of view names corresponding to a componentSofaName followed by the<a name="line.132"></a>
<FONT color="green">133</FONT>             *            aggregateSofaName that it is mapped to. An even number of names must be passed in<a name="line.133"></a>
<FONT color="green">134</FONT>             *            or else an IllegalArgumentException will be thrown. See<a name="line.134"></a>
<FONT color="green">135</FONT>             *            {@link SofaMappingFactory#createSofaMapping(String, String, String)}<a name="line.135"></a>
<FONT color="green">136</FONT>             */<a name="line.136"></a>
<FONT color="green">137</FONT>            public void add(String componentName, AnalysisEngineDescription aed, String... viewNames) {<a name="line.137"></a>
<FONT color="green">138</FONT>                    if (componentNames.contains(componentName)) {<a name="line.138"></a>
<FONT color="green">139</FONT>                            throw new IllegalArgumentException("the component name '" + componentName<a name="line.139"></a>
<FONT color="green">140</FONT>                                            + "' has already been used for another added analysis engine description.");<a name="line.140"></a>
<FONT color="green">141</FONT>                    }<a name="line.141"></a>
<FONT color="green">142</FONT>                    if (viewNames != null &amp;&amp; viewNames.length % 2 != 0) {<a name="line.142"></a>
<FONT color="green">143</FONT>                            throw new IllegalArgumentException(<a name="line.143"></a>
<FONT color="green">144</FONT>                                            "an even number of view names is required (as "<a name="line.144"></a>
<FONT color="green">145</FONT>                                                            + "component view name, aggregate view name pairs) for the AggregateBuilder.add "<a name="line.145"></a>
<FONT color="green">146</FONT>                                                            + "method. " + viewNames.length + " view names passed: "<a name="line.146"></a>
<FONT color="green">147</FONT>                                                            + Arrays.asList(viewNames));<a name="line.147"></a>
<FONT color="green">148</FONT>                    }<a name="line.148"></a>
<FONT color="green">149</FONT>    <a name="line.149"></a>
<FONT color="green">150</FONT>                    analysisEngineDescriptions.add(aed);<a name="line.150"></a>
<FONT color="green">151</FONT>                    componentNames.add(componentName);<a name="line.151"></a>
<FONT color="green">152</FONT>    <a name="line.152"></a>
<FONT color="green">153</FONT>                    if (viewNames != null) {<a name="line.153"></a>
<FONT color="green">154</FONT>                            for (int i = 0; i &lt; viewNames.length; i += 2) {<a name="line.154"></a>
<FONT color="green">155</FONT>                                    sofaMappings.add(SofaMappingFactory.createSofaMapping(componentName, viewNames[i],<a name="line.155"></a>
<FONT color="green">156</FONT>                                                    viewNames[i + 1]));<a name="line.156"></a>
<FONT color="green">157</FONT>                            }<a name="line.157"></a>
<FONT color="green">158</FONT>                    }<a name="line.158"></a>
<FONT color="green">159</FONT>            }<a name="line.159"></a>
<FONT color="green">160</FONT>    <a name="line.160"></a>
<FONT color="green">161</FONT>            /**<a name="line.161"></a>
<FONT color="green">162</FONT>             * Provide a sofa mapping for a component from the component's view to the aggregate view.<a name="line.162"></a>
<FONT color="green">163</FONT>             *<a name="line.163"></a>
<FONT color="green">164</FONT>             * @param componentName<a name="line.164"></a>
<FONT color="green">165</FONT>             *            the name of the component<a name="line.165"></a>
<FONT color="green">166</FONT>             * @param componentViewName<a name="line.166"></a>
<FONT color="green">167</FONT>             *            the name of the component view<a name="line.167"></a>
<FONT color="green">168</FONT>             * @param aggregateViewName<a name="line.168"></a>
<FONT color="green">169</FONT>             *            the name of the aggregate view to map the component view to.<a name="line.169"></a>
<FONT color="green">170</FONT>             */<a name="line.170"></a>
<FONT color="green">171</FONT>            public void addSofaMapping(String componentName, String componentViewName,<a name="line.171"></a>
<FONT color="green">172</FONT>                            String aggregateViewName) {<a name="line.172"></a>
<FONT color="green">173</FONT>                    if (componentNames.contains(componentName)) {<a name="line.173"></a>
<FONT color="green">174</FONT>                            sofaMappings.add(SofaMappingFactory.createSofaMapping(componentName, componentViewName,<a name="line.174"></a>
<FONT color="green">175</FONT>                                            aggregateViewName));<a name="line.175"></a>
<FONT color="green">176</FONT>                    }<a name="line.176"></a>
<FONT color="green">177</FONT>                    else {<a name="line.177"></a>
<FONT color="green">178</FONT>                            throw new IllegalArgumentException("No component with the name '" + componentName<a name="line.178"></a>
<FONT color="green">179</FONT>                                            + "' has been added to this builder.  Sofa mappings may only be added for "<a name="line.179"></a>
<FONT color="green">180</FONT>                                            + "components that have been added to this builder. ");<a name="line.180"></a>
<FONT color="green">181</FONT>                    }<a name="line.181"></a>
<FONT color="green">182</FONT>            }<a name="line.182"></a>
<FONT color="green">183</FONT>    <a name="line.183"></a>
<FONT color="green">184</FONT>            /**<a name="line.184"></a>
<FONT color="green">185</FONT>             * Set the flow controller description of the aggregate engine created by this builder.<a name="line.185"></a>
<FONT color="green">186</FONT>             *<a name="line.186"></a>
<FONT color="green">187</FONT>             * @param flowControllerDescription<a name="line.187"></a>
<FONT color="green">188</FONT>             *            see {@link FlowControllerFactory}<a name="line.188"></a>
<FONT color="green">189</FONT>             */<a name="line.189"></a>
<FONT color="green">190</FONT>            public void setFlowControllerDescription(FlowControllerDescription flowControllerDescription) {<a name="line.190"></a>
<FONT color="green">191</FONT>                    this.flowControllerDescription = flowControllerDescription;<a name="line.191"></a>
<FONT color="green">192</FONT>            }<a name="line.192"></a>
<FONT color="green">193</FONT>    <a name="line.193"></a>
<FONT color="green">194</FONT>            /**<a name="line.194"></a>
<FONT color="green">195</FONT>             * This method simply delegates to<a name="line.195"></a>
<FONT color="green">196</FONT>             * {@link AnalysisEngineFactory#createAggregate(List, TypeSystemDescription, TypePriorities, SofaMapping[], Object...)}<a name="line.196"></a>
<FONT color="green">197</FONT>             * with the data collected by this builder.<a name="line.197"></a>
<FONT color="green">198</FONT>             *<a name="line.198"></a>
<FONT color="green">199</FONT>             * @return an aggregate analysis engine<a name="line.199"></a>
<FONT color="green">200</FONT>             * @throws ResourceInitializationException<a name="line.200"></a>
<FONT color="green">201</FONT>             */<a name="line.201"></a>
<FONT color="green">202</FONT>            public AnalysisEngine createAggregate() throws ResourceInitializationException {<a name="line.202"></a>
<FONT color="green">203</FONT>                    return AnalysisEngineFactory.createAggregate(analysisEngineDescriptions, componentNames,<a name="line.203"></a>
<FONT color="green">204</FONT>                                    typeSystemDescription, typePriorities,<a name="line.204"></a>
<FONT color="green">205</FONT>                                    sofaMappings.toArray(new SofaMapping[sofaMappings.size()]),<a name="line.205"></a>
<FONT color="green">206</FONT>                                    flowControllerDescription);<a name="line.206"></a>
<FONT color="green">207</FONT>            }<a name="line.207"></a>
<FONT color="green">208</FONT>    <a name="line.208"></a>
<FONT color="green">209</FONT>            /**<a name="line.209"></a>
<FONT color="green">210</FONT>             * This method simply delegates to<a name="line.210"></a>
<FONT color="green">211</FONT>             * {@link AnalysisEngineFactory#createAggregateDescription(List, TypeSystemDescription, TypePriorities, SofaMapping[], Object...)}<a name="line.211"></a>
<FONT color="green">212</FONT>             * with the data collected by this builder.<a name="line.212"></a>
<FONT color="green">213</FONT>             *<a name="line.213"></a>
<FONT color="green">214</FONT>             * @return a description of an aggregate analysis engine<a name="line.214"></a>
<FONT color="green">215</FONT>             * @throws ResourceInitializationException<a name="line.215"></a>
<FONT color="green">216</FONT>             */<a name="line.216"></a>
<FONT color="green">217</FONT>            public AnalysisEngineDescription createAggregateDescription()<a name="line.217"></a>
<FONT color="green">218</FONT>                            throws ResourceInitializationException {<a name="line.218"></a>
<FONT color="green">219</FONT>                    return AnalysisEngineFactory.createAggregateDescription(analysisEngineDescriptions,<a name="line.219"></a>
<FONT color="green">220</FONT>                                    componentNames, typeSystemDescription, typePriorities,<a name="line.220"></a>
<FONT color="green">221</FONT>                                    sofaMappings.toArray(new SofaMapping[sofaMappings.size()]),<a name="line.221"></a>
<FONT color="green">222</FONT>                                    flowControllerDescription);<a name="line.222"></a>
<FONT color="green">223</FONT>            }<a name="line.223"></a>
<FONT color="green">224</FONT>    }<a name="line.224"></a>




























































</PRE>
</BODY>
</HTML>
